<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BaseGenericDao xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/base/BaseGenericDao.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: BaseGenericDao.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/base/BaseGenericDao.html $</em>
<a name="4" href="#4">4</a>   <em> * JdbcGenericDao.java - genericdao - Apr 18, 2008 10:07:08 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.base;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.Serializable;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.ArrayList;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.Iterator;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.List;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.Map;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.genericdao.api.GenericDao;
<a name="26" href="#26">26</a>  <strong>import</strong> org.sakaiproject.genericdao.api.caching.CacheProvider;
<a name="27" href="#27">27</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.DaoOperationInterceptor;
<a name="28" href="#28">28</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.ReadInterceptor;
<a name="29" href="#29">29</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.WriteInterceptor;
<a name="30" href="#30">30</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Search;
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.genericdao.base.caching.NonCachingCacheProvider;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em>/**<em>*</em></em>
<a name="34" href="#34">34</a>  <em> * This is the simple base implementation which includes shared methods and should be extended,</em>
<a name="35" href="#35">35</a>  <em> * this handles the caching checks and the interceptors on the basic methods</em>
<a name="36" href="#36">36</a>  <em> * </em>
<a name="37" href="#37">37</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="38" href="#38">38</a>  <em> */</em>
<a name="39" href="#39">39</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/base/BaseGenericDao.html">BaseGenericDao</a> implements <a href="../../../../org/sakaiproject/genericdao/api/GenericDao.html">GenericDao</a> {
<a name="40" href="#40">40</a>  
<a name="41" href="#41">41</a>     <em>/**<em>*</em></em>
<a name="42" href="#42">42</a>  <em>    * MUST be overridden</em>
<a name="43" href="#43">43</a>  <em>    */</em>
<a name="44" href="#44">44</a>     <strong>protected</strong> &lt;T> T baseFindById(Class&lt;T> type, Serializable id) {
<a name="45" href="#45">45</a>         <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Not Implemented"</span>);
<a name="46" href="#46">46</a>     }
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>     <em>/**<em>*</em></em>
<a name="49" href="#49">49</a>  <em>    * MUST be overridden</em>
<a name="50" href="#50">50</a>  <em>    */</em>
<a name="51" href="#51">51</a>     <strong>protected</strong> Serializable baseCreate(Class&lt;?> type, Object object) {
<a name="52" href="#52">52</a>         <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Not Implemented"</span>);
<a name="53" href="#53">53</a>     }
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>     <em>/**<em>*</em></em>
<a name="56" href="#56">56</a>  <em>    * MUST be overridden</em>
<a name="57" href="#57">57</a>  <em>    */</em>
<a name="58" href="#58">58</a>     <strong>protected</strong> <strong>void</strong> baseUpdate(Class&lt;?> type, Object id, Object object) {
<a name="59" href="#59">59</a>         <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Not Implemented"</span>);
<a name="60" href="#60">60</a>     }
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>     <em>/**<em>*</em></em>
<a name="63" href="#63">63</a>  <em>    * MUST be overridden</em>
<a name="64" href="#64">64</a>  <em>    */</em>
<a name="65" href="#65">65</a>     <strong>protected</strong> &lt;T> <strong>boolean</strong> baseDelete(Class&lt;T> type, Serializable id) {
<a name="66" href="#66">66</a>         <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Not Implemented"</span>);
<a name="67" href="#67">67</a>     }
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>     <em>/**<em>*</em></em>
<a name="70" href="#70">70</a>  <em>    * Get the id value from a persistent object,</em>
<a name="71" href="#71">71</a>  <em>    * this expects that the object is persistent so it should already be checked&lt;br/></em>
<a name="72" href="#72">72</a>  <em>    * Override this if desired</em>
<a name="73" href="#73">73</a>  <em>    * @param entity any persistent object</em>
<a name="74" href="#74">74</a>  <em>    * @return the id value or null if it is unset</em>
<a name="75" href="#75">75</a>  <em>    */</em>
<a name="76" href="#76">76</a>     <strong>protected</strong> Serializable baseGetIdValue(Object entity) {
<a name="77" href="#77">77</a>        Class&lt;?> type = findClass(entity);
<a name="78" href="#78">78</a>        String idProp = getIdProperty(type);
<a name="79" href="#79">79</a>        Object idValue = <strong>null</strong>;
<a name="80" href="#80">80</a>        <strong>if</strong> (idProp == <strong>null</strong>) {
<a name="81" href="#81">81</a>           <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not find id property for this class type: "</span> + type);
<a name="82" href="#82">82</a>        } <strong>else</strong> {
<a name="83" href="#83">83</a>           idValue = ReflectUtils.getInstance().getFieldValue(entity, idProp);
<a name="84" href="#84">84</a>        }
<a name="85" href="#85">85</a>        Serializable serialId = <strong>null</strong>;
<a name="86" href="#86">86</a>        <strong>if</strong> (idValue != <strong>null</strong>) {
<a name="87" href="#87">87</a>           <strong>if</strong> (! (idValue instanceof Serializable)) {
<a name="88" href="#88">88</a>              serialId = idValue.toString();
<a name="89" href="#89">89</a>           }
<a name="90" href="#90">90</a>        }
<a name="91" href="#91">91</a>        <strong>return</strong> serialId;
<a name="92" href="#92">92</a>     }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>     <em>/**<em>*</em></em>
<a name="95" href="#95">95</a>  <em>    * Find the class type of a persistent object,</em>
<a name="96" href="#96">96</a>  <em>    * needed in the case that we are working with something that wraps it's objects&lt;br/></em>
<a name="97" href="#97">97</a>  <em>    * Override this if desired</em>
<a name="98" href="#98">98</a>  <em>    * @param entity a persistent entity</em>
<a name="99" href="#99">99</a>  <em>    * @return the persistent class type OR null if it cannot be found</em>
<a name="100" href="#100">100</a> <em>    */</em>
<a name="101" href="#101">101</a>    <strong>protected</strong> Class&lt;?> findClass(Object entity) {
<a name="102" href="#102">102</a>       <strong>if</strong> (entity == <strong>null</strong>) {
<a name="103" href="#103">103</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot find class type of null entity object"</span>);
<a name="104" href="#104">104</a>       }
<a name="105" href="#105">105</a>       Class&lt;?> type = entity.getClass();
<a name="106" href="#106">106</a>       <strong>return</strong> type;
<a name="107" href="#107">107</a>    }
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>    <em class="comment">// COMMON CODE</em>
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>    <strong>private</strong> List&lt;Class&lt;?>> classes;
<a name="112" href="#112">112</a>    <em>/**<em>*</em></em>
<a name="113" href="#113">113</a> <em>    * This does a nice bit of exception handling for us and verifies that</em>
<a name="114" href="#114">114</a> <em>    * this class is valid to perform a DAO operation with</em>
<a name="115" href="#115">115</a> <em>    * @param type class type of the persistent object to check</em>
<a name="116" href="#116">116</a> <em>    * @return A valid entityClass type resolved to be the same as</em>
<a name="117" href="#117">117</a> <em>    * the ones usable by this DAO</em>
<a name="118" href="#118">118</a> <em>    */</em>
<a name="119" href="#119">119</a>    <strong>protected</strong> Class&lt;?> checkClass(Class&lt;?> type) {
<a name="120" href="#120">120</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="121" href="#121">121</a>          <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"type cannot be null"</span>);
<a name="122" href="#122">122</a>       }
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>       <strong>if</strong> (classes == <strong>null</strong>) {
<a name="125" href="#125">125</a>          <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"persistent classes must be set"</span>);
<a name="126" href="#126">126</a>       }
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>       <strong>for</strong> (Iterator&lt;Class&lt;?>> i = classes.iterator(); i.hasNext();) {
<a name="129" href="#129">129</a>          Class&lt;?> concrete = (Class&lt;?>) i.next();
<a name="130" href="#130">130</a>          <strong>if</strong> (concrete.isAssignableFrom(type)) {
<a name="131" href="#131">131</a>             <strong>return</strong> concrete;
<a name="132" href="#132">132</a>          }
<a name="133" href="#133">133</a>       }
<a name="134" href="#134">134</a>       <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not resolve this class "</span> + 
<a name="135" href="#135">135</a>             type + <span class="string">" as part of the set of persistent objects: "</span> +
<a name="136" href="#136">136</a>             classes.toString());
<a name="137" href="#137">137</a>    }
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>    <strong>private</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider;
<a name="140" href="#140">140</a>    <em>/**<em>*</em></em>
<a name="141" href="#141">141</a> <em>    * @return the current cache provider</em>
<a name="142" href="#142">142</a> <em>    */</em>
<a name="143" href="#143">143</a>    <strong>protected</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> getCacheProvider() {
<a name="144" href="#144">144</a>       <strong>if</strong> (cacheProvider == <strong>null</strong>) {
<a name="145" href="#145">145</a>          cacheProvider = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/base/caching/NonCachingCacheProvider.html">NonCachingCacheProvider</a>();
<a name="146" href="#146">146</a>       }
<a name="147" href="#147">147</a>       <strong>return</strong> cacheProvider;
<a name="148" href="#148">148</a>    }
<a name="149" href="#149">149</a>    <em>/**<em>*</em></em>
<a name="150" href="#150">150</a> <em>    * Set the cache provider to an implementation of {@link CacheProvider},</em>
<a name="151" href="#151">151</a> <em>    * this will be set to {@link NonCachingCacheProvider} if this is not set explicitly</em>
<a name="152" href="#152">152</a> <em>    * @param cacheProvider</em>
<a name="153" href="#153">153</a> <em>    */</em>
<a name="154" href="#154">154</a>    <strong>public</strong> <strong>void</strong> setCacheProvider(<a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider) {
<a name="155" href="#155">155</a>       <strong>this</strong>.cacheProvider = cacheProvider;
<a name="156" href="#156">156</a>    }
<a name="157" href="#157">157</a>    <em>/**<em>*</em></em>
<a name="158" href="#158">158</a> <em>    * @return the cache name used for storing this type of persistent object</em>
<a name="159" href="#159">159</a> <em>    */</em>
<a name="160" href="#160">160</a>    <strong>protected</strong> String getCacheName(Class&lt;?> type) {
<a name="161" href="#161">161</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="162" href="#162">162</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="163" href="#163">163</a>       }
<a name="164" href="#164">164</a>       <strong>return</strong> type.getName();
<a name="165" href="#165">165</a>    }
<a name="166" href="#166">166</a>    <em>/**<em>*</em></em>
<a name="167" href="#167">167</a> <em>    * @return the cachename used for storing search results for this type of object</em>
<a name="168" href="#168">168</a> <em>    */</em>
<a name="169" href="#169">169</a>    <strong>protected</strong> String getSearchCacheName(Class&lt;?> type) {
<a name="170" href="#170">170</a>       <strong>if</strong> (type == <strong>null</strong>) {
<a name="171" href="#171">171</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="172" href="#172">172</a>       }
<a name="173" href="#173">173</a>       <strong>return</strong> <span class="string">"search:"</span> + type.getName();
<a name="174" href="#174">174</a>    }
<a name="175" href="#175">175</a>    <em>/**<em>*</em></em>
<a name="176" href="#176">176</a> <em>    * Creates all the caches for the current set of persistent types,</em>
<a name="177" href="#177">177</a> <em>    * this should be called in the init for the generic dao being used after persistent classes are loaded</em>
<a name="178" href="#178">178</a> <em>    */</em>
<a name="179" href="#179">179</a>    <strong>protected</strong> <strong>void</strong> initCaches() {
<a name="180" href="#180">180</a>       <strong>for</strong> (Class&lt;?> type : classes) {
<a name="181" href="#181">181</a>          getCacheProvider().createCache(getCacheName(type));
<a name="182" href="#182">182</a>          getCacheProvider().createCache(getSearchCacheName(type));
<a name="183" href="#183">183</a>       }
<a name="184" href="#184">184</a>    }
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>    <em class="comment">// INTERCEPTOR methods</em>
<a name="187" href="#187">187</a> 
<a name="188" href="#188">188</a>    <strong>private</strong> Map&lt;Class&lt;?>, ReadInterceptor> readInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, ReadInterceptor>();
<a name="189" href="#189">189</a>    <strong>private</strong> Map&lt;Class&lt;?>, WriteInterceptor> writeInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, WriteInterceptor>();
<a name="190" href="#190">190</a>    <em>/**<em>*</em></em>
<a name="191" href="#191">191</a> <em>    * Adds the provided interceptor to the current set of interceptors</em>
<a name="192" href="#192">192</a> <em>    * @param interceptor</em>
<a name="193" href="#193">193</a> <em>    */</em>
<a name="194" href="#194">194</a>    <strong>public</strong> <strong>void</strong> addInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="195" href="#195">195</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="196" href="#196">196</a>          Class&lt;?> type = interceptor.interceptType();
<a name="197" href="#197">197</a>          <strong>if</strong> (type != <strong>null</strong>) {
<a name="198" href="#198">198</a>             <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="199" href="#199">199</a>                readInterceptors.put(type, (ReadInterceptor) interceptor);
<a name="200" href="#200">200</a>             }
<a name="201" href="#201">201</a>             <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="202" href="#202">202</a>                writeInterceptors.put(type, (WriteInterceptor) interceptor);
<a name="203" href="#203">203</a>             }
<a name="204" href="#204">204</a>          }
<a name="205" href="#205">205</a>       }
<a name="206" href="#206">206</a>    }
<a name="207" href="#207">207</a>    <em>/**<em>*</em></em>
<a name="208" href="#208">208</a> <em>    * Removes the provided interceptor from the current set of interceptors</em>
<a name="209" href="#209">209</a> <em>    * @param interceptor</em>
<a name="210" href="#210">210</a> <em>    */</em>
<a name="211" href="#211">211</a>    <strong>public</strong> <strong>void</strong> removeInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="212" href="#212">212</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="213" href="#213">213</a>          Class&lt;?> type = interceptor.interceptType();
<a name="214" href="#214">214</a>          <strong>if</strong> (type != <strong>null</strong>) {
<a name="215" href="#215">215</a>             <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="216" href="#216">216</a>                readInterceptors.remove(type);
<a name="217" href="#217">217</a>             }
<a name="218" href="#218">218</a>             <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="219" href="#219">219</a>                writeInterceptors.remove(type);
<a name="220" href="#220">220</a>             }
<a name="221" href="#221">221</a>          }
<a name="222" href="#222">222</a>       }
<a name="223" href="#223">223</a>    }
<a name="224" href="#224">224</a>    <em>/**<em>*</em></em>
<a name="225" href="#225">225</a> <em>    * Makes the given interceptor the only active interceptor,</em>
<a name="226" href="#226">226</a> <em>    * removes all others and adds only this one</em>
<a name="227" href="#227">227</a> <em>    * @param interceptor</em>
<a name="228" href="#228">228</a> <em>    */</em>
<a name="229" href="#229">229</a>    <strong>public</strong> <strong>void</strong> setInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="230" href="#230">230</a>       <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="231" href="#231">231</a>          readInterceptors.clear();
<a name="232" href="#232">232</a>          writeInterceptors.clear();
<a name="233" href="#233">233</a>          addInterceptor(interceptor);
<a name="234" href="#234">234</a>       }
<a name="235" href="#235">235</a>    }
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>    <strong>protected</strong> <strong>void</strong> beforeRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="238" href="#238">238</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="239" href="#239">239</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="240" href="#240">240</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="241" href="#241">241</a>             interceptor.beforeRead(operation, ids, search);
<a name="242" href="#242">242</a>          }
<a name="243" href="#243">243</a>       }
<a name="244" href="#244">244</a>    }
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>    <strong>protected</strong> <strong>void</strong> afterRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search, Object[] entities) {
<a name="247" href="#247">247</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="248" href="#248">248</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="249" href="#249">249</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="250" href="#250">250</a>             interceptor.afterRead(operation, ids, search, entities);
<a name="251" href="#251">251</a>          }
<a name="252" href="#252">252</a>       }
<a name="253" href="#253">253</a>    }
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>    <strong>protected</strong> <strong>void</strong> beforeWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities) {
<a name="256" href="#256">256</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="257" href="#257">257</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="258" href="#258">258</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="259" href="#259">259</a>             interceptor.beforeWrite(operation, ids, entities);
<a name="260" href="#260">260</a>          }
<a name="261" href="#261">261</a>       }
<a name="262" href="#262">262</a>    }
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>    <strong>protected</strong> <strong>void</strong> afterWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities, <strong>int</strong> changes) {
<a name="265" href="#265">265</a>       <strong>if</strong> (type != <strong>null</strong>) {
<a name="266" href="#266">266</a>          <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="267" href="#267">267</a>          <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="268" href="#268">268</a>             interceptor.afterWrite(operation, ids, entities, changes);
<a name="269" href="#269">269</a>          }
<a name="270" href="#270">270</a>       }
<a name="271" href="#271">271</a>    }
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a>    <em class="comment">// ********* PUBLIC methods ****************</em>
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a> 
<a name="276" href="#276">276</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="277" href="#277">277</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#getPersistentClasses()</em>
<a name="278" href="#278">278</a> <em class="comment">    */</em>
<a name="279" href="#279">279</a>    <strong>public</strong> List&lt;Class&lt;?>> getPersistentClasses() {
<a name="280" href="#280">280</a>       <strong>return</strong> <strong>new</strong> ArrayList&lt;Class&lt;?>>(classes);
<a name="281" href="#281">281</a>    }
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="284" href="#284">284</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#invokeTransactionalAccess(java.lang.Runnable)</em>
<a name="285" href="#285">285</a> <em class="comment">    */</em>
<a name="286" href="#286">286</a>    <strong>public</strong> <strong>void</strong> invokeTransactionalAccess(Runnable toinvoke) {
<a name="287" href="#287">287</a>       toinvoke.run();
<a name="288" href="#288">288</a>    }
<a name="289" href="#289">289</a> 
<a name="290" href="#290">290</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="291" href="#291">291</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.GenericDao#findById(java.lang.Class, java.io.Serializable)</em>
<a name="292" href="#292">292</a> <em class="comment">    */</em>
<a name="293" href="#293">293</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="294" href="#294">294</a>    <strong>public</strong> &lt;T> T findById(Class&lt;T> type, Serializable id) {
<a name="295" href="#295">295</a>       checkClass(type);
<a name="296" href="#296">296</a>       <strong>if</strong> (id == <strong>null</strong>) {
<a name="297" href="#297">297</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"id must be set to find persistent object"</span>);
<a name="298" href="#298">298</a>       }
<a name="299" href="#299">299</a> 
<a name="300" href="#300">300</a>       T entity = <strong>null</strong>;
<a name="301" href="#301">301</a>       <em class="comment">// check cache first</em>
<a name="302" href="#302">302</a>       String key = id.toString();
<a name="303" href="#303">303</a>       String cacheName = getCacheName(type);
<a name="304" href="#304">304</a>       <strong>if</strong> (getCacheProvider().exists(cacheName, key)) {
<a name="305" href="#305">305</a>          entity = (T) getCacheProvider().get(cacheName, key);
<a name="306" href="#306">306</a>       } <strong>else</strong> {
<a name="307" href="#307">307</a>          <em class="comment">// not in cache so go to the DB</em>
<a name="308" href="#308">308</a>    
<a name="309" href="#309">309</a>          <em class="comment">// before interceptor</em>
<a name="310" href="#310">310</a>          String operation = <span class="string">"findById"</span>;
<a name="311" href="#311">311</a>          beforeRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="312" href="#312">312</a>    
<a name="313" href="#313">313</a>          entity = baseFindById(type, id);
<a name="314" href="#314">314</a>    
<a name="315" href="#315">315</a>          <em class="comment">// now put the item in the cache</em>
<a name="316" href="#316">316</a>          getCacheProvider().put(cacheName, key, entity);
<a name="317" href="#317">317</a>    
<a name="318" href="#318">318</a>          <em class="comment">// after interceptor</em>
<a name="319" href="#319">319</a>          afterRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, <strong>new</strong> Object[] {entity});
<a name="320" href="#320">320</a>       }
<a name="321" href="#321">321</a>       <strong>return</strong> entity;
<a name="322" href="#322">322</a>    }
<a name="323" href="#323">323</a> 
<a name="324" href="#324">324</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="325" href="#325">325</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#create(java.lang.Object)</em>
<a name="326" href="#326">326</a> <em class="comment">    */</em>
<a name="327" href="#327">327</a>    <strong>public</strong> <strong>void</strong> create(Object object) {
<a name="328" href="#328">328</a>       Class&lt;?> type = findClass(object);
<a name="329" href="#329">329</a>       checkClass(type);
<a name="330" href="#330">330</a> 
<a name="331" href="#331">331</a>       String operation = <span class="string">"create"</span>;
<a name="332" href="#332">332</a>       beforeWrite(operation, type, <strong>null</strong>, <strong>new</strong> Object[] {object});
<a name="333" href="#333">333</a> 
<a name="334" href="#334">334</a>       Serializable idValue = baseCreate(type, object);
<a name="335" href="#335">335</a> 
<a name="336" href="#336">336</a>       <em class="comment">// clear the search caches</em>
<a name="337" href="#337">337</a>       getCacheProvider().clear(getSearchCacheName(type));
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>       afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="340" href="#340">340</a>    }
<a name="341" href="#341">341</a> 
<a name="342" href="#342">342</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="343" href="#343">343</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#update(java.lang.Object)</em>
<a name="344" href="#344">344</a> <em class="comment">    */</em>
<a name="345" href="#345">345</a>    <strong>public</strong> <strong>void</strong> update(Object object) {
<a name="346" href="#346">346</a>       Class&lt;?> type = findClass(object);
<a name="347" href="#347">347</a>       checkClass(type);
<a name="348" href="#348">348</a> 
<a name="349" href="#349">349</a>       Serializable idValue = baseGetIdValue(object);
<a name="350" href="#350">350</a>       <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="351" href="#351">351</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not get an id value from the supplied object, cannot update without an id: "</span> + object);
<a name="352" href="#352">352</a>       }
<a name="353" href="#353">353</a> 
<a name="354" href="#354">354</a>       String operation = <span class="string">"update"</span>;
<a name="355" href="#355">355</a>       beforeWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object});
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>       baseUpdate(type, idValue, object);
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>       <em class="comment">// clear the search caches</em>
<a name="360" href="#360">360</a>       getCacheProvider().clear(getSearchCacheName(type));
<a name="361" href="#361">361</a>       <em class="comment">// clear the cache entry since this was updated</em>
<a name="362" href="#362">362</a>       String key = idValue.toString();
<a name="363" href="#363">363</a>       String cacheName = getCacheName(type);
<a name="364" href="#364">364</a>       getCacheProvider().remove(cacheName, key);
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a>       afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="367" href="#367">367</a>    }
<a name="368" href="#368">368</a> 
<a name="369" href="#369">369</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="370" href="#370">370</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#save(java.lang.Object)</em>
<a name="371" href="#371">371</a> <em class="comment">    */</em>
<a name="372" href="#372">372</a>    <strong>public</strong> <strong>void</strong> save(Object object) {
<a name="373" href="#373">373</a>       Serializable id = baseGetIdValue(object);
<a name="374" href="#374">374</a>       <strong>if</strong> (id == <strong>null</strong>) {
<a name="375" href="#375">375</a>          create(object);
<a name="376" href="#376">376</a>       } <strong>else</strong> {
<a name="377" href="#377">377</a>          update(object);
<a name="378" href="#378">378</a>       }
<a name="379" href="#379">379</a>    }
<a name="380" href="#380">380</a> 
<a name="381" href="#381">381</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="382" href="#382">382</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Object)</em>
<a name="383" href="#383">383</a> <em class="comment">    */</em>
<a name="384" href="#384">384</a>    <strong>public</strong> <strong>void</strong> delete(Object object) {
<a name="385" href="#385">385</a>       Class&lt;?> type = findClass(object);
<a name="386" href="#386">386</a>       Serializable id = baseGetIdValue(object);
<a name="387" href="#387">387</a>       delete(type, id);
<a name="388" href="#388">388</a>    }
<a name="389" href="#389">389</a> 
<a name="390" href="#390">390</a>    <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="391" href="#391">391</a> <em class="comment">    * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Class, java.io.Serializable)</em>
<a name="392" href="#392">392</a> <em class="comment">    */</em>
<a name="393" href="#393">393</a>    <strong>public</strong> &lt;T> <strong>boolean</strong> delete(Class&lt;T> type, Serializable id) {
<a name="394" href="#394">394</a>       checkClass(type);
<a name="395" href="#395">395</a> 
<a name="396" href="#396">396</a>       String operation = <span class="string">"delete"</span>;
<a name="397" href="#397">397</a>       beforeWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="398" href="#398">398</a> 
<a name="399" href="#399">399</a>       <strong>boolean</strong> removed = baseDelete(type, id);
<a name="400" href="#400">400</a> 
<a name="401" href="#401">401</a>       <strong>if</strong> (removed) {
<a name="402" href="#402">402</a>          <em class="comment">// clear the search caches</em>
<a name="403" href="#403">403</a>          getCacheProvider().clear(getSearchCacheName(type));
<a name="404" href="#404">404</a>          <em class="comment">// clear this from the cache</em>
<a name="405" href="#405">405</a>          String key = id.toString();
<a name="406" href="#406">406</a>          String cacheName = getCacheName(type);
<a name="407" href="#407">407</a>          getCacheProvider().remove(cacheName, key);
<a name="408" href="#408">408</a>          
<a name="409" href="#409">409</a>          afterWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, 1);
<a name="410" href="#410">410</a>       }
<a name="411" href="#411">411</a>       <strong>return</strong> removed;
<a name="412" href="#412">412</a>    }
<a name="413" href="#413">413</a> 
<a name="414" href="#414">414</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

